DocumentationCommunityAPI Reference

Development Quickstart

Get up and running with our REST API and start developing your integration.

Suggest Edits

Integrating Qordoba into your app or website can begin as soon as you create a Stripe account, requiring only three steps:

  • Obtain your API keys so Qordoba can authenticate your integration’s API requests
  • Make a test API request to confirm everything is up and running

Step 1: Obtain your API keys

Qordoba authenticates your API requests using your account’s API keys. If you do not include your key when making an API request, or use one that is incorrect or outdated, Qordoba returns an error.

Your API keys are available in the Developer Integrations section under setting. We include randomly generated API keys in our code examples if you are not logged in. Replace these with your own or log in to see code examples populated with your own test API keys.

📘

Note

Use only your expiry date for any test API keys for testing and development. This ensures that you don't accidentally using your live keys.

If you cannot see your secret API keys in the Dashboard, this means you do not have access to them. Contact your Qordoba account’s owner and ask to be added to their team as a developer.

Step 2: Make a test API request

To check that your integration is working correctly, make a test API request using your key to get Qordoba score 

curl --request GET \
  --url 'https://app.qordoba.com/v3/contentscore/organizations/organizationId/workspaces/workspaceId/documents/documentId/personas/personaId/score?organizationId=organizationId&workspaceId=workspaceId&documentId=documentId&personaId=personaId'

var request = require("request");

var options = { method: 'GET',
  url:
   'https://app.qordoba.com/v3/contentscore/organizations/organizationId/workspaces/workspaceId/documents/documentId/personas/personaId/score',
  qs:
   { organizationId: 'organizationId',
     workspaceId: 'workspaceId',
     documentId: 'documentId',
     personaId: 'personaId' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'

url = URI("https://app.qordoba.com/v3/contentscore/organizations/organizationId/workspaces/workspaceId/documents/documentId/personas/personaId/score?organizationId=organizationId&workspaceId=workspaceId&documentId=documentId&personaId=personaId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://app.qordoba.com/v3/contentscore/organizations/organizationId/workspaces/workspaceId/documents/documentId/personas/personaId/score?organizationId=organizationId&workspaceId=workspaceId&documentId=documentId&personaId=personaId");

xhr.send(data);

import requests

url = "https://app.qordoba.com/v3/contentscore/organizations/organizationId/workspaces/workspaceId/documents/documentId/personas/personaId/score"

querystring = {"organizationId":"organizationId","workspaceId":"workspaceId","documentId":"documentId","personaId":"personaId"}

response = requests.request("GET", url, params=querystring)

print(response.text)

Qordoba returns a Charge object in response to your API request.

{
  "snapshotTime": 0,
  "documentScore": 0,
  "breakdown": [
    {
      "category": "string",
      "issueCount": 0,
      "score": 0,
      "enabled": true
    }
  ]
}

Updated about 2 years ago