Category: Intro


Intro

By 7425wpczar,

INTRO

You can use our test environment or interactive web console like Postman to test our API.

While you are testing, here are some helpful pointers to assist your debugging:

  • Ensure you are always using the POST method for each call.
  • Always use your Subscription key

API REFERENCE

The API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website’s client-side code). JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects.

AUTHENTICATION

Authenticate your account when using the API by including your secret API key in the request. You can manage your API keys in the Earth Networks Enterprise Portal. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such GitHub, client-side code, and so forth.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.