Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 1.85 KB

README.md

File metadata and controls

36 lines (25 loc) · 1.85 KB

NablaFlow API JS example client build

Description

NablaFlow's API talks GraphQL.

Please consult the documentation.

Authentication

Third-party clients can access the API on behalf of existing NablaFlow users. In short, a user must first register with us and then connect their account inside your application via a typical OAuth2 authorization code flow.

In order to integrate with NablaFlow's API you need to be in possess of a CLIENT_ID and a CLIENT_SECRET, used to perform the OAuth2 authentication code flow.
It's not possible to create a client and submit it for approval yet, so if you are interested, please get in touch with us. We're working to add this feature soon.

Prerequisites

Test run

  • cp .env.example .env and fill out CLIENT_ID and CLIENT_SECRET.
  • Run ./get_access_token.sh to perform the OAuth2 authentication code flow. Follow instructions.
  • Copy the access token from oauth2c into .env, as ACCESS_TOKEN=....
  • yarn install
  • yarn run codegen
  • Edit examples/archiwind/get_simulation_v1.ts and fill in simulation id and token
  • node esbuild.js
  • node dist/archiwind/get_simulation_v1.js

There are many examples in the examples folder.