Skip to main content

Getting Started

You need an account with a subscription plan to use Erguvan API. Create an account by visiting erguvan.co/api/auth/signin if you do not have an account yet. Send an email to support@erguvan.co to learn about how to start your subscription.

Getting Started​

Obtaining an API Key​

To access API functions, you need to create an API key after activating your subscription. You can create an API key by visiting erguvan.co/settings/api-keys.

General Concepts​

Erguvan API is a RESTful API. It uses JSON for serialization of requests and responses.

  • All requests should be made to the base URL: https://www.erguvan.co/api
  • All requests should include the Content-Type: application/json header.
  • All requests should include the Authorization: Bearer YOUR_ERGUVAN_API_KEY header.
  • All requests should be made over HTTPS.
  • All requests and responses use the UTF-8 character set.

For more information about API concepts, endpoints, and models, please see the rest of our API documentation.