Skip to content

Resources available for developers

API Gateway

The API Gateway and its developer portal are your companion for an easier integration. Learn how to use it in the dedicated article here.

To assist you during development, take advantage of detailed logs in the sandbox environment: You don’t need to log your requests/responses during development, you can simply consult the logs directly from the developer portal.

NOTE

Detailed logs are not available in production, only in sandbox. We therefore recommend maintaining a logging system on your side, at least for error handling.

Create alerts to be notified in case of errors. You can receive alerts through various channels (including Slack) whenever your application exceeds a certain error rate (among other triggers). This is useful to be informed of issues occurring in production.

Bruno collection

Our Bruno collection is available here.

It contains our entire API reference and is configured so you only need to provide environment variables to start using our APIs immediately.

It also comes with scenarios representing the most common use cases (registration, online sales, etc.).

Our status page

Each environment has a dedicated status page allowing you to:

  • Check the status and availability of our APIs
  • Subscribe to receive alerts for upcoming or ongoing maintenance

For the FR/ES environment, the status page is https://resamania.statuspage.io/

Example source code

Some integration examples can be found in the dedicated GitHub repository.

Getting Started Using AI

If you are using an AI coding agent like Claude Code, Cursor, or OpenCode, you can start with a prompt that gives the agent a Resamania-specific playbook before it touches your project.

The prompt below tells the agent where to find our integration conventions (API Gateway, OAuth2, required headers, business workflows) and how to make sensible defaults when you haven't made a choice yet. Paste this into your agent to get started:

I'm building a partner integration with the Resamania API.
Fetch and follow the instructions from https://doc.resamania.com/for-agents. Treat the returned Markdown as the source of truth for how to authenticate, structure requests, and implement business workflows in this session.

After the agent reads the instructions, it should guide you step by step and keep the integration aligned with Resamania's conventions. Once your integration is ready for our test phase, ask the same agent to run our pre-submission review skill — it produces an endpoint inventory and a checklist report you can share with our API team to speed up the review.

Components of a request

A typical request sent to our API will look like this:

curl --location --globoff 'https://gateway.prod.gravitee.stadline.tech/resa2-staging/${clientToken}/class_events' \
--header 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...' \
--header 'x-user-club-id: /demoapi/clubs/1210' \
--header 'x-user-network-node-id: /demoapi/network_nodes/1053' \
--header 'x-gravitee-api-key: xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx'

We can identify the following components:

ComponentDescription
https://gateway.prod.gravitee.stadline.tech/required
The base URL of our API Gateway
demoapirequired
This is the clientToken: the unique identifier of a Resamania client
x-user-club-idrequired
Header containing the IRI of the club for which you want to retrieve/store information
x-user-network-node-idHeader containing the IRI of the network node for which you want to retrieve/store information.

optional
Optional if your client has only one club

required
Required if you work with club chains
x-gravitee-api-keyrequired
Your authentication key for the API Gateway
Bearer ...required
The token generated via an authentication endpoint