API Authentication

Authenticating to the API uses a client credential model for back-end access only. A baseline level of Postman or another API tool is preferred.

You will need to retrieve information from Astra Events in order to proceed.

  1. Log in to Ad Astra as an Astra Admin user
  2. Navigate to Schedule > Events
    • A new tab should open to Events Calendar
  3. In the bottom-left corner, click on the User menu item > Organization Settings
    1. Open a new tab
    2. Make the Untitled Request a POST call

Enter the OAuth 2.0 Access Token Request URL as the API URL
API screenshot.pngOpen Astra Integration

Screenshot 2024-11-27 101115.png

What you will need (input these values in Steps 3, 6, and 10 below):

  • OAuth 2.0 Access Token Request URL
  • OAuth 2.0 Client ID
  • OAuth 2.0 Secret

 

Enabling your bearer access token

Install Postman (if necessary)

  1. Open a new tab
  2. Make the Untitled Request a POST call
  3. Enter the OAuth 2.0 Access Token Request URL as the API URL
    API screenshot.png

  4. Go to the Auth tab
  5. Select Basic Auth in the Auth Type dropdown
  6. Input the following values from above
    • Username = OAuth 2.0 Client ID
    • Password = OAuth 2.0 Secret
  7. Go to the Headers tab
    • Make sure there are no custom Headers (this should only happen if you re-use a tab in Postman)
  8. Go to the Body tab
  9. Select x-www-form-urlencoded (depending on your version of Postman, this could be found in a dropdown or as a radio button selection)
  10. Input the following values:
    • client_id = OAuth 2.0 Client ID
    • grant_type = client_credentials
    • scope = partner-api/activities
      send.png

  11. Press the Send button -

    Doing so should give you an accessible Bearer token that will last for 6 hours
    accesstoken.png


Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.