Developer Platform

Rakenna sähköisen allekirjoituksen integraatio

Bink API tarjoaa kehittäjille tehokkaat työkalut dokumenttien hallintaan ja sähköiseen allekirjoitukseen – suoraan omasta sovelluksestasi.

Luo tili ja aloita Swagger-dokumentaatio ↗

Miksi Bink API?

Yksi rajapinta – kaikki mitä tarvitset sähköiseen allekirjoitukseen ja dokumenttien hallintaan.

📄

Dokumenttien hallinta

Luo, hae ja hallitse dokumentteja ohjelmallisesti. Tuki useille tiedostomuodoille ja kansiorakenteelle.

✍️

Sähköinen allekirjoitus

Lähetä dokumentit allekirjoitettavaksi yhdellä API-kutsulla. Tukee sekä sähköposti- että vahvaa tunnistautumista.

🔐

Turvallinen ja luotettava

API-avainpohjainen tunnistautuminen, salatut yhteydet ja EU-alueen mukainen tietosuoja.

⚡

Nopea integraatio

RESTful JSON API, selkeä dokumentaatio ja yksinkertaiset endpointit – integraatio valmiina minuuteissa.

🏢

Monen tiimin tuki

Tenant-pohjainen arkkitehtuuri mahdollistaa useiden organisaatioiden ja tiimien hallinnan yhdellä API-avaimella.

🧪

Sandbox-ympäristö

Testaa integraatiota riskittömästi sandbox-ympäristössä ennen tuotantoon siirtymistä. Telia- ja maksupalvelutarjoajamme-demot käytettävissä.

Näin pääset alkuun

Viisi yksinkertaista vaihetta Bink API:n käyttöönottoon.

1

Luo tili

Rekisteröidy osoitteessa app.bink.fi ja vahvista sähköpostiosoitteesi. Tilin luominen on ilmaista.

2

Luo API-avain

Siirry asetuksiin kohdasta Settings → API ja klikkaa Create API Key. Kopioi avain talteen – sitä ei voi nähdä enää myöhemmin.

3

Tutustu Swagger-dokumentaatioon

Interaktiivinen API-dokumentaatio on vapaasti saatavilla osoitteessa sandbox-api.bink.fi/docs – ei vaadi kirjautumista.

4

Testaa sandbox-ympäristössä

Kokeile API-kutsuja sandbox-ympäristössä osoitteessa sandbox.bink.fi. Käytössä on Telia- ja maksupalvelutarjoajamme demoversiot, joilla voit testata kaikki ominaisuudet riskittömästi.

5

Siirry tuotantoon

Kun integraatio on testattu sandboxissa, vaihda API-osoitteeksi api.bink.fi ja aloita tuotantokäyttö. Tuotannon API-osoite: https://api.bink.fi

⚠️

Suojaa API-avaimesi. Älä koskaan tallenna avainta suoraan lähdekoodiin. Käytä ympäristömuuttujia. Jos epäilet avaimesi vuotaneen, peruuta se välittömästi ja luo uusi.

🧪

Sandbox-ympäristö: Käytä sandbox-ympäristöä kehityksen ja testauksen aikana. Sandbox API: sandbox-api.bink.fi · Sandbox UI: sandbox.bink.fi · Swagger: sandbox-api.bink.fi/docs

Esimerkkipyyntö

Luo dokumentti ja liitä allekirjoittajat yhdellä kutsulla.

cURL · Sandbox
# Sandbox-ympäristö (testaus)
  curl -X POST https://sandbox-api.bink.fi/api/documents/quick-create \
    -H "x-api-key: YOUR_API_KEY" \
    -F "file=@sopimus.pdf" \
    -F "title=Yhteistyösopimus" \
    -F "tenantId=your-tenant-id" \
    -F "signingMethod=email" \
    -F "signingMessage=Tarkista ja allekirjoita perjantaihin mennessä." \
    -F 'signees=[
      {"email":"matti@esimerkki.fi","name":"Matti Meikäläinen"},
      {"email":"maija@esimerkki.fi","name":"Maija Meikäläinen"}
    ]'
  
  # Tuotanto: vaihda URL → https://api.bink.fi/api/documents/quick-create
Vastaus · JSON
{
    "message": "Document created successfully",
    "document": {
      "id": "doc_abc123",
      "name": "Yhteistyösopimus",
      "status": "pending"
    },
    "signees": [
      { "email": "matti@esimerkki.fi", "name": "Matti Meikäläinen" },
      { "email": "maija@esimerkki.fi", "name": "Maija Meikäläinen" }
    ],
    "contentType": "application/pdf"
  }

API-referenssi

Kaikki käytettävissä olevat endpointit yhdellä silmäyksellä. Täydellinen interaktiivinen dokumentaatio: sandbox-api.bink.fi/docs ↗

Dokumentit documents
POST /api/documents/quick-create Pikaluonti allekirjoittajilla

Luo dokumentin lataamalla tiedoston multipart-muodossa ja liittää allekirjoittajat yhdellä kutsulla.

Request body · multipart/form-data

KenttäTyyppiKuvaus
file*binaryLadattava tiedosto
titlestringValinnainen. Oletuksena tiedoston nimi.
tenantId*stringOrganisaation tunniste
signingMethodstringValinnainen. Allekirjoitustapa: "email" (sähköpostivarmenne, oletusarvo) tai "strong" (vahva tunnistautuminen).
signingMessagestringValinnainen. Henkilökohtainen viesti allekirjoitussähköpostissa.
signees*JSON stringJSON-taulukko allekirjoittajista: [{"email":"…","name":"…"}]

Vastaukset

200 400 403 500
GET /api/documents Listaa dokumentit

Palauttaa kirjautuneen käyttäjän dokumentit valitussa tenantissa.

Query-parametrit

KenttäTyyppiKuvaus
tenantId*stringOrganisaation tunniste
folderIdstringValinnainen. Kansion tunniste.

Vastaukset

200 400 403
200 Vastauksen rakenne · application/json
Esimerkki array
[
    {
      "id": "string",
      "tenantId": "string",
      "folderId": "string",
      "name": "string",
      "status": "signed",
      "pinned": true,
      "createdAt": "2026-02-17T11:57:11.607Z",
      "updatedAt": "2026-02-17T11:57:11.607Z"
    }
  ]
400 403 Virherakenne
Esimerkki object
{
    "error": "string"
  }
GET /api/documents/{documentId} Hae dokumentti

Palauttaa yksittäisen dokumentin tiedot tunnisteen perusteella.

Polkuparametrit

KenttäTyyppiKuvaus
documentId*stringDokumentin tunniste

Vastaukset

200 404
404 Virherakenne
Esimerkki object
{
    "error": "string"
  }
POST /api/documents/{documentId}/send-for-signing Lähetä allekirjoitettavaksi

Lähettää allekirjoituskutsut kaikille dokumentin allekirjoittajille.

Polkuparametrit

KenttäTyyppiKuvaus
documentId*stringDokumentin tunniste

Vastaukset

200 400 404 429
200 Vastauksen rakenne · application/json
Esimerkki object
{
    "message": "string",
    "result": [
      {
        "email": "string",
        "status": "string",
        "data": {},
        "error": {}
      }
    ],
    "credit": {
      "tenantId": "string",
      "email": 0,
      "strong": 0
    }
  }
400 404 Virherakenne
Esimerkki object
{
    "error": "string"
  }
429 Rate limit · liian monta pyyntöä
Esimerkki object
{
    "error": "string",
    "reminderCooldownUntil": "2026-02-17T11:57:11.637Z"
  }
Organisaatiot tenants
GET /api/tenants Listaa organisaatiot

Palauttaa kirjautuneen käyttäjän organisaatiot (tenantit). Ei parametreja.

Vastaukset

200 401
200 Vastauksen rakenne · application/json
Esimerkki array
[
    {
      "id": "string",
      "name": "string",
      "logo": "string",
      "emailLanguage": "fi",
      "createdAt": "2026-02-17T11:57:11.621Z",
      "updatedAt": "2026-02-17T11:57:11.621Z"
    }
  ]
401 Virherakenne
Esimerkki object
{
    "error": "string"
  }
GET /api/tenants/{tenantId} Hae jäsenyystiedot

Palauttaa kirjautuneen käyttäjän jäsenyystiedot valitussa organisaatiossa.

Polkuparametrit

KenttäTyyppiKuvaus
tenantId*stringOrganisaation tunniste

Vastaukset

200 401 403
Palvelun tila meta
GET /api/status Tilatarkistus

Palvelun health check -endpoint. Palauttaa palvelun tilan.

Vastaukset

200

Valmiina rakentamaan?

Luo ilmainen tili, generoi API-avain ja testaa integraatiota sandbox-ympäristössä jo tänään.

Luo ilmainen tili Swagger-dokumentaatio ↗