Skip to main content
All CollectionsAccount Settings
How to authenticate for the Orbify API?
How to authenticate for the Orbify API?
Michał Wieczorek avatar
Written by Michał Wieczorek
Updated over a week ago

In this article, we'll guide you through the process of authenticating with the Orbify API, empowering you to seamlessly integrate Orbify's powerful features into your own applications. Orbify, at the forefront of innovative platforms, extends its functionality through an API, providing developers with the opportunity to incorporate Orbify's capabilities directly into their projects. By following the steps outlined below, you'll gain a comprehensive understanding of how to authenticate with the Orbify API, ensuring secure access to Orbify's resources for your applications.

Step 1: Generate the API Token

The first step in authenticating with the Orbify API is to generate an API token.

Step 2: Setup an Authorisation Header

With the API token generated, the next step is to set up an authorization header for your API requests. This header contains your API token and is necessary for Orbify to authenticate your application. This ensures that Orbify can verify the authenticity of your requests and grant access accordingly.

X-Access-Token: ACCESS_TOKEN

Step 3: Perform a sample request

To confirm that your authentication setup is working correctly, it's a good idea to perform a sample request to the Orbify API. This can be done using tools like cURL or through code in your preferred programming language. Make a simple GET request to a sample endpoint, such as retrieving user information or fetching data from a test resource. Include the authorization header with your API token in the request, and check the response to ensure that you receive the expected data.

curl --location "https://mjolnir.api.orbify.app/api/v2/{YOUR_APPLICATION_IDENTIFIER}/report_templates" --header "X-Access-Token: {YOUR_ACCESS_TOKEN}"

For all the available API methods, please refer to the API documentation here.

Conclusion

Authentication is a fundamental aspect of interacting with the Orbify API securely. By following these simple steps, developers can ensure that their applications can access Orbify's resources smoothly and securely. With proper authentication in place, developers can leverage the power of the Orbify API to enhance their applications with features and functionality that Orbify provides. As you continue to explore and integrate with the Orbify API, remember to prioritize security and adhere to best practices to safeguard your application and its data.

Did this answer your question?