Clarabase
  • Welcome
  • Introduction
    • What is Clarabase?
  • Basics
    • Creating a Resource (Schema)
    • Making Requests
      • Pagination & Filtering
    • Code Generation
    • Data Viewer
  • Database Guides
    • Postgres
    • MySQL
    • MongoDB
    • Oracle
    • Firestore
    • SQL Server
  • Guides
    • Filtering on user data
    • Adding a Clarabase API to your projects
Powered by GitBook
On this page
  1. Basics

Making Requests

PreviousCreating a Resource (Schema)NextPagination & Filtering

Last updated 3 months ago

Once you have a Resource defined, Clarabase will automatically generate an OpenAPI spec and GraphQL schema for you. Your API is immediately available to accept requests, both using HTTP/REST and GraphQL. (There are more APIs on the roadmap, including HTTP-Avro and gRPC, both will be excellent for your high performance needs)

You can make requests directly in the browser using the OpenAPI dashboard (authentication will be handled automatically for you). This is a great way to experiment with your API and get an idea of how to make the requests.

In addition, you can also manage your resource with the provided GraphQL API. You can use the GraphiQL interface to experiment with making calls via the GraphQL API and to view the GraphQL schema.

Your URL

You will have a unique url for making requests to your api. This can be found at Settings > API Settings. Note that there is a separate url for HTTP/REST and GraphQL (see dropdown).

This is your base url for your api. For example, if you have a resource called Companies, and your base url is "abc.clarabase.com", then you can make an http request for this resource at "abc.clarabase.com/api/v1/companies".

Authentication

Authentication is achieved by requesting an auth token with your client credentials. Your credentials can be found at Settings > API Settings. You will need to generate a client secret to start requesting access tokens if you haven't done so already. Note that you will only be able to see your secret once, so be sure to copy it securely immediately, otherwise you'll have to generate a new secret.

You can generate a new secret at anytime, and it's encouraged to do so regularly. Note this will invalidate any existing, JWT tokens that have already been issued using that credential.

To request a token with your client credentials, you simply need to make a POST /auth/token request with your client_id and client_secret. The response will return an access token that should be sent in an authorization header when making API requests, for example Authorization: Bearer <accessToken>.

If the access token expires or is invalidated, a new one can be created by making another request to get an accessToken.

Using the OpenAPI and GraphQL APIs in the Browser
Finding the base url for your API
Generating your client secret