Get started

Getting Started with API Access
If you're a subscriber to the Inform Direct platform, getting started is simple:

  1. Generate a Sandbox API Key
    Go to "Account" in the Inform Direct platform.

    Select "Manage API keys" under the action list.

    Select "Add API Key" under the action list — this will generate a sandbox-ready key for testing your integration.

  2. Test Your Integration
    Use the sandbox API key to make successful calls to all the endpoints and ensure the following endpoints return successful, authenticated responses:

    - Add company
    - Remove company
    - Get company
    - Get companies

    These successful calls will then be used in acquiring a live production API key below.

  3. Request Production Access
    Once testing is complete in the sandbox environment, generate a Production API Key in your account and email support@informdirect.co.uk with:

    - Your organisation name
    - The last 6 characters of your sandbox API key
    - The last 6 characters of your production API key that you wish to become active.

    Our technical team will validate your sandbox calls before enabling your production key.

Powered by