Testing

Sandbox Testing
Once you have your sandbox credentials (private-api-key and public-dealer-id) you can start testing in sandbox. See our Onboard with Koalafi page for steps to retrieve your sandbox credentials.

Our APIs are built using graphQL, if you are new to it we recommend this tutorial.

GraphQL Playground

Our sandbox GraphQL playground is the perfect place to build different queries and mutations. The playground has tabs that open our docs and the schema. As you build your queries, the playground will validate the schema which makes it a great tool to become more familiar with both GraphQL and our schema. The Koalafi playground is only available in our sandbox environment and for security reasons is not enabled in production.

To use the playground you will need to include the following headers on any queries/mutations

{
"public-dealer-id": <your-PDI-here>,
"private-api-key": <your-key-here>
}

Postman

Collection

If you are already familiar with GraphQL or would like some guidance on how to create and structure your queries you can use our postman collection. Our postman collection has example requests for all of our common queries/mutations. The endpoint and some headers are setup to be used with a postman environment but you will need to add your API credentials to the headers. The headers are configured to use a Postman Environment, please see the following section Environment for configuring your postman environment.

Koalafi_Integrations_Public Postman Collection

Import Our Collection

  1. Open the Postman desktop client. In the upper left click Import
  1. In the menu that opens up click Link and paste the URL for the Koalafi postman collection: https://www.getpostman.com/collections/1d2587bb2cc9a22ce1aa. Click continue
  1. Verify the below details and click Import
  1. The collection should not be imported and ready to use. Inside the collection, the requests are organized in the same structure as our Direct API docs.

Environment

We recommend using a Koalafi postman environment for testing. You can use the following JSON key/value pairs to set up your Koalafi-sandbox env.

{
    "name": "Koalafi-Sandbox",
    "values": [
        {
            "key": "base_url",
            "value": "https://application-edge-service.sandbox.koalafi.com",
            "enabled": true
        },
        {
            "key": "private-api-key",
            "value": "<your key> ",
            "enabled": true
        },
    {
            "key": "public-dealer-id",
            "value": "<your pdi>",
            "enabled": true
        },
        {
            "key": "rn-high-approval",
            "value": "011000028",
            "enabled": true
        },
        {
            "key": "rn-hard-decline",
            "value": "011001234",
            "enabled": true
        },
        {
            "key": "rn-soft-decline",
            "value": "011001276",
            "enabled": true
        },
        {
            "key": "base_",
            "value": "",
            "enabled": true
        },
        {
            "key": "rn-soft-decline-identity",
            "value": "011000536",
            "enabled": true
        }
    ],
}

Creating your Postman Environment

  1. In the postman desktop app, click on Environments on the panel on the left side. Click on the + in the upper left corner.
  1. This will create a new empty environment for you. Change the name to something meaningful - we chose Koalafi-Sandbox-Public. Copy over the key-value pairs from the JSON above. Each key-value pair is it's own line in the environment. The type for each pair should be set to default.
  1. This is what our env looks like filled out - be sure to fill in public-dealer-id and private-api-key with your own credentials
  1. Your environment setup is complete and you should now see your new environment under the environments tab. You should now be able to use our collection

Connecting to our Environments