Swagger API Access

graphiteConnect provides an interactive OpenAPI Swagger page that includes up-to-date documentation for all public API endpoints, along with the ability to send live API calls and receive real responses directly in your browser.

The Swagger UI is the recommended tool for exploring the API during integration development and testing.

Swagger URL

https://app.graphiteconnect.com/api/public/api/v1/documentation/#

Getting Access

To use the Swagger UI effectively, you will need:

A graphiteConnect POC environment account — This account allows you to make changes through the web application and observe how web app changes interact with the API. Contact [email protected] to request POC access.
An API Token — Contact [email protected] to obtain your API key if you do not already have one.

Authenticating in Swagger

Once you have your API Token:

Navigate to the Swagger URL above.
Click the "Authorize" button near the top of the page.
Enter your API Token in the authorization dialog and confirm.

The Swagger UI will use this token for all subsequent API calls made during your session.

Making API Calls

To make a live API call from the Swagger UI:

Browse the endpoint list and click on an endpoint to expand its documentation.
Click "Try it out" on the expanded endpoint.
Fill in any required path parameters, query parameters, or request body fields.
Click "Execute" to send the request.
Scroll down to the Response section to see the HTTP status code and response body.

Use Cases

The Swagger UI is particularly useful for:

Exploring available endpoints and their parameters without writing any code
Testing authentication to confirm your API token is valid
Verifying API behavior during integration development (e.g., inspecting the shape of profile data for a specific supplier)
Debugging unexpected API responses by comparing request parameters against live results