Introduction Concepts App Registration Making API Test Calls Authentication OData Search Events and Webhooks Specifications Profiles API Agencies API Licenses API Accounts API Plans API Policies API Events API Carriers API Content API

Resistering Your App To Use The Zywave API

  1. Request access to Organization Admin

    To start building an application using the Zywave API, you first must register your application through the Organization Admin tool. If you don't have access to the Organization Admin tool, contact your primary contact at Zywave and let them know you're interested in creating an application using the Zywave API.

  2. Use Organization Admin to register your application

    Click Registered Apps > Add application, then fill out the required information. Make sure you pay careful attention to the following.

    • Application secret

      This automatically generated value is important for authentication with OAuth 2.0 and should be stored in a secure location. Once this value has been saved, it can't be accessed again from Zywave. If this value is ever lost, you will need to generate or provide a new value and save the the changes.

    • Grant types

      These values dictate the method or methods your application will use to retrieve access tokens from IdentityServer. Consult the documentation for the particular library or framework you use for OAuth to determine which works best for your application.

    • Scopes

      These values determine what data your application may access and when operations it may perform on the data. Consult the specification for the particular Zywave API endpoint you intend to use in order to determine which values to set.