Postman Collection

Ortege API Postman Collection Documentation

The Ortege API Postman Collection provides developers with a convenient way to explore and interact with the Ortege API. This collection includes pre-built requests for accessing blockchain data across REST, GraphQL, and WebSocket endpoints. By using this collection, you can quickly test queries, explore data structures, and integrate Ortege’s powerful datasets into your applications.

1. Getting Started

Prerequisites

To get started with the Ortege API Postman Collection, you’ll need:

  1. Postman: Download and install Postman from here.

  2. JWT Token: Obtain a JWT token from the Ortege team for secure API access.

Importing the Collection

  1. Download the Ortege API Postman Collection JSON file from the Github Repository.

  2. In Postman, go to File > Import, choose the JSON file, and import it.

Setting Up the Environment

Creating an environment allows you to manage variables like your JWT token and the base API URL, making it easy to switch environments or update configurations.

  1. In Postman, go to Environments > + New Environment.

  2. Name your environment (e.g., “Ortege API”).

  3. Add the following variables:

    • jwt_token: Enter your JWT token value here.

    • base_url_rest: Set this to https://api-staging.ortege.ai/cubejs-api/v1 for REST

Configuring Authorization

  1. Open the imported collection.

  2. Go to the Authorization tab of the collection.

  3. Select Bearer Token as the authorization type.

  4. Set the Token field to {{jwt_token}} to link to your environment variable.

2. Troubleshooting Common Issues

  • 401 Unauthorized Error: Verify your JWT token is correct and included in the jwt_token variable within your environment.

  • Query Syntax Errors: Check the structure of your query against the Query Syntax Documentation to ensure it’s valid for the API endpoint.

PreviousAPINextAuthentication

Last updated