Ingresse Developer Portal

Welcome to the Ingresse API developer portal. You'll find comprehensive guides and documentation to help you start working with Ingresse API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Quickstart

Get up and running your first integration by these easy steps.

Integrating with Ingresse platform is easy and it requires small steps in order to start:

  1. Ask for an API key so we can start a new environment for you.
  2. Make a test API request to confirm that you are ok to go.
  3. You may prefer to download one of our client libraries.

1. Ask for an API key

Ingresse is a TaaS (ticketing as a service) platform. It means that you can create a whole new ticketing company on top of Ingresse. Because of that, today, every new API key is individually generated by our team.

But, worry no more, we are here to help you with that. Just go ahead and fill out this form and we will answer you as soon as possible.

Sandbox

Our integration and tools are all-around events. We recommend you to create test events in order to perform your integration requests. Even your order requests can be made and refunded using our APIs.

Ingresse does provide have an integration environment, but it is provided under request. If your integration tool requires it, please get in contact with us through your integration partner.

2. Make a test API call

You can test your API keys making a simple request to place an order and get your first transaction ID.

Request (API v2)

curl -X POST \
  'http://api.ingresse.com/shop?apikey={{publickey}}' \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -d '{
  "extras": [
    {
      "externalId": "999",
      "name": "Coke (355ml)",
      "quantity": 1,
      "unitPrice": 100
    }  
  ]
}'

Answer

{
  "responseData":{
  "data":{
    "transactionId":"99999-88888-E2C8082E1133AF47EB36602C33F219F82290FB23",
    "gateway":{
      "name":"ingresse"
    },
    "status":"pending",
      "availablePaymentMethods": {
        "CartaoCredito": {
          "type": "CartaoCredito",
          "installments":[
            {
              "quantity":1,
              "value":100,
              "total":100,
              "taxValue":0,
              "shippingCost":0
            }
          ]
        }
      },
      "message":""
    }
  },
  "responseDetails":"OK",
  "responseError":null,
  "responseStatus":200
}

If that is what happened, you are ready to start your integration with Ingresse.

3. Install an SDK (optional)

Depending on the programming language that you are working with, we may help you with an SDK client.

SDKs under continuous progress

The SDKs listed here are under continuous progress. It means they are available for production usage, as Ingresse uses itself, but they may not have all the methods you have available in the API reference.

Quickstart


Get up and running your first integration by these easy steps.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.