Renewly API-documentatie

Programmatische toegang tot uw contractdata via een eenvoudige REST API

60/min
Rate limit
API Key
Authenticatie
REST
API-formaat

Aan de slag

1. Maak een API-sleutel aan

Ga naar Settings → API Keys en maak een nieuwe API-sleutel aan. Bewaar deze veilig - hij wordt maar één keer getoond.

2. Voer uw eerste request uit

Voeg uw API-sleutel toe aan de X-API-Key header:

curl https://renewly.gg/api/v1/contracts \
  -H "X-API-Key: rnwly_live_abc123..."

Authenticatie

Alle API-requests moeten uw API-sleutel bevatten in de X-API-Key header:

X-API-Key: rnwly_live_abc123...

Beveiliging: Commit API-sleutels nooit naar versiebeheer. Gebruik environment variables in uw applicaties.

Rate limits

Algemene endpoints60 requests/min
Export-endpoint10 requests/hour

Rate limits gelden per API-sleutel. Als u de limiet overschrijdt, ontvangt u een 429 Too Many Requests response met een Retry-After header.

Foutcodes

401Unauthorized

Ongeldige, ontbrekende, verlopen of ingetrokken API-sleutel

403Forbidden

U heeft geen toestemming om deze resource te benaderen

429Too Many Requests

Rate limit overschreden. Controleer de Retry-After header

500Internal Server Error

Er ging iets mis aan onze kant. Neem contact op met support als dit aanhoudt

Endpoints

GET/api/v1/contracts

Toon alle contracten waartoe u toegang heeft (persoonlijke + organisatiecontracten).

Queryparameters

statusFilter op status (bijv. completed, pending)
organization_idFilter op organisatie-UUID
limitResultaten per pagina (standaard: 50, max: 100)
offsetPaginering-offset (standaard: 0)

Voorbeeldrequest

curl https://renewly.gg/api/v1/contracts?status=completed&limit=10 \
  -H "X-API-Key: rnwly_live_abc123..."

Voorbeeldresponse

{
  "success": true,
  "data": {
    "contracts": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "title": "SaaS Subscription Agreement",
        "status": "completed",
        "file_name": "contract.pdf",
        "file_size": 245678,
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T11:00:00Z",
        "organization_id": null
      }
    ],
    "pagination": {
      "limit": 10,
      "offset": 0,
      "total": 42
    }
  }
}
GET/api/v1/contracts/:id

Haal gedetailleerde informatie op over een specifiek contract, inclusief geëxtraheerde data.

Voorbeeldrequest

curl https://renewly.gg/api/v1/contracts/550e8400-e29b-41d4-a716-446655440000 \
  -H "X-API-Key: rnwly_live_abc123..."

Voorbeeldresponse

{
  "success": true,
  "data": {
    "contract": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "title": "SaaS Subscription Agreement",
      "status": "completed",
      "file_name": "contract.pdf",
      "data": {
        "expiration_date": "2025-12-31",
        "renewal_date": "2025-11-01",
        "auto_renewal": true,
        "contract_value": 50000,
        "currency": "USD",
        "parties": {
          "provider": "Acme Corp",
          "client": "Example Inc"
        },
        "summary": "Annual SaaS subscription...",
        "confidence_score": 0.95
      }
    }
  }
}
POST/api/v1/contracts/export

Exporteer contracten naar CSV-formaat. Gelimiteerd tot 10 requests per uur.

Request body (optioneel)

{
  "status": "completed",
  "organization_id": "org-uuid"
}

Voorbeeldrequest

curl -X POST https://renewly.gg/api/v1/contracts/export \
  -H "X-API-Key: rnwly_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{"status":"completed"}' \
  --output contracts.csv

Retourneert een CSV-bestand met contractdata. De response bevat Content-Type: text/csv.

Codevoorbeelden

JavaScript / TypeScript

// List contracts
const response = await fetch('https://renewly.gg/api/v1/contracts', {
  headers: {
    'X-API-Key': process.env.RENEWLY_API_KEY
  }
});

const { data } = await response.json();
console.log(`Found ${data.contracts.length} contracts`);

// Get contract details
const contract = await fetch(`https://renewly.gg/api/v1/contracts/${contractId}`, {
  headers: {
    'X-API-Key': process.env.RENEWLY_API_KEY
  }
}).then(r => r.json());

console.log(`Expires: ${contract.data.contract.data.expiration_date}`);

Python

import os
import requests

API_KEY = os.getenv('RENEWLY_API_KEY')
BASE_URL = 'https://renewly.gg/api/v1'

# List contracts
response = requests.get(
    f'{BASE_URL}/contracts',
    headers={'X-API-Key': API_KEY}
)
contracts = response.json()['data']['contracts']
print(f'Found {len(contracts)} contracts')

# Get contract details
contract_id = '550e8400-e29b-41d4-a716-446655440000'
response = requests.get(
    f'{BASE_URL}/contracts/{contract_id}',
    headers={'X-API-Key': API_KEY}
)
contract = response.json()['data']['contract']
print(f'Expires: {contract["data"]["expiration_date"]}')

Hulp nodig?

Heeft u vragen of loopt u ergens tegenaan? We helpen u graag.

Contact opnemen met support