Belge talepleri API

Bir potansiyel müşteriden bağlantıyla belge isteyin — giriş yapması gerekmez.

Modül kodu lead_documents · 7 işlem · 3 veri modeli · 6 olay. Bir anahtar ya da token, arkasındaki kişinin bu modülde yapabildiğinden fazlasını asla yapamaz; satır düzeyindeki güvenlik uygulamadakiyle birebir aynıdır. Yetki kapsamları: lead_documents (hepsi), lead_documents:read (yalnız okuma) ya da lead_documents:<yetenek>.

Kaynaklar

Listeler limit (en çok 200), cursor, order (ör. -created_at), fields ve q alır; diğer her sorgu parametresi bir sütun süzgecidir: ?status=paid, ?total[gte]=100, ?id[in]=a,b, ?x=null.

İşlemler

lead_documents.issue_link

Potansiyel müşteriden belge iste — Tek bir potansiyel müşteri için bir dosya yükleme bağlantısı açar ve istenen belgelere bağlar.

Gereken izin lead_documents:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/lead_documents.issue_link

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: lead_documents.link_issued

Neye yazar: lead_document_link (insert) — Ties the link to the lead and retires the previous one

curl -X POST https://app.getera.io/api/v1/lead_document_links/actions/issue_link \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"leadId":"LEAD_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "lead_documents.link_issued"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leadDocumentLinks.issueLink({
  leadId: "LEAD_ID"
})

era lead_document_links issue_link \
  --lead-id "LEAD_ID"

{
  "name": "era__lead_documents__issue_link",
  "arguments": {
    "leadId": "LEAD_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde lead_documents:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 lead_not_found, lead_archived, no_requests, request_not_available, upload_link_not_open, upload_link_taken · 429 çok sık istek

lead_documents.renew_link

Belge bağlantısının süresini uzat — Potansiyel müşteriye gönderilen bağlantının süresini, elindeki adresi koruyarak uzatır.

Gereken izin lead_documents:write · veriyi değiştirir

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: lead_documents.link_renewed

curl -X POST https://app.getera.io/api/v1/actions/lead_documents.renew_link \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"leadId":"LEAD_ID","days":1}'

{
  "ok": true,
  "result": "…",
  "events": [
    "lead_documents.link_renewed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.actions.run("lead_documents.renew_link", {
  leadId: "LEAD_ID",
  days: 1
})

era run lead_documents.renew_link \
  --lead-id "LEAD_ID" \
  --days 1

{
  "name": "era__lead_documents__renew_link",
  "arguments": {
    "leadId": "LEAD_ID",
    "days": 1
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde lead_documents:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 lead_not_found, lead_archived, no_open_link · 429 çok sık istek

lead_documents.review

Belgeyi kabul et veya reddet — Gönderilen hakkında bir karar kaydeder; ret, kişiye nedenini bildirir.

Gereken izin lead_documents:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/lead_documents.review

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: lead_documents.reviewed

Neye yazar: lead_document (update) — Records the decision

curl -X POST https://app.getera.io/api/v1/lead_documents/LEAD_DOCUMENT_ID/actions/review \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"decision":"accepted"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "lead_documents.reviewed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leadDocuments.review("LEAD_DOCUMENT_ID", {
  decision: "accepted"
})

era lead_documents review LEAD_DOCUMENT_ID \
  --decision "accepted"

{
  "name": "era__lead_documents__review",
  "arguments": {
    "id": "LEAD_DOCUMENT_ID",
    "decision": "accepted"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde lead_documents:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, already_in_that_state, reason_required · 429 çok sık istek

lead_documents.revoke_link

Potansiyel müşterinin belge bağlantısını kapat — Potansiyel müşteriye gönderilen bağlantıyı çalışmaz hâle getirir. Gönderdikleri kalır.

Gereken izin lead_documents:write · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/lead_documents.revoke_link

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: lead_documents.link_revoked

Neye yazar: lead_document_link (update) — Retires the join; files closes the link

curl -X POST https://app.getera.io/api/v1/lead_document_links/actions/revoke_link \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"leadId":"LEAD_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "lead_documents.link_revoked"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leadDocumentLinks.revokeLink({
  leadId: "LEAD_ID"
})

era lead_document_links revoke_link \
  --lead-id "LEAD_ID"

{
  "name": "era__lead_documents__revoke_link",
  "arguments": {
    "leadId": "LEAD_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde lead_documents:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 lead_not_found, lead_archived, no_open_link · 429 çok sık istek

lead_documents.set_request

Belge talebi ekle veya değiştir — İşletmenin bir potansiyel müşteriden ne istediği — pasaport, diploma — ve hangi dosyaları kabul ettiği.

Gereken izin lead_documents:manage · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/lead_documents.set_request

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: lead_documents.request_changed

Neye yazar: lead_document_request (upsert) — Writes the request

curl -X POST https://app.getera.io/api/v1/lead_document_requests/LEAD_DOCUMENT_REQUEST_ID/actions/set_request \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Name"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "lead_documents.request_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leadDocumentRequests.setRequest("LEAD_DOCUMENT_REQUEST_ID", {
  name: "Name"
})

era lead_document_requests set_request LEAD_DOCUMENT_REQUEST_ID \
  --name "Name"

{
  "name": "era__lead_documents__set_request",
  "arguments": {
    "id": "LEAD_DOCUMENT_REQUEST_ID",
    "name": "Name"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde lead_documents:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, name_taken · 429 çok sık istek

lead_documents.set_request_active

Belge talebini aç veya kapat — Gönderilmiş olanlara dokunmadan bir belgeyi istemeyi bırakır.

Gereken izin lead_documents:manage · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/lead_documents.set_request_active

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: lead_documents.request_changed

Neye yazar: lead_document_request (update) — Opens or closes it

curl -X POST https://app.getera.io/api/v1/lead_document_requests/LEAD_DOCUMENT_REQUEST_ID/actions/set_request_active \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"active":true}'

{
  "ok": true,
  "result": "…",
  "events": [
    "lead_documents.request_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leadDocumentRequests.setRequestActive("LEAD_DOCUMENT_REQUEST_ID", {
  active: true
})

era lead_document_requests set_request_active LEAD_DOCUMENT_REQUEST_ID \
  --active true

{
  "name": "era__lead_documents__set_request_active",
  "arguments": {
    "id": "LEAD_DOCUMENT_REQUEST_ID",
    "active": true
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde lead_documents:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, already_in_that_state · 429 çok sık istek

lead_documents.submit

Potansiyel müşterinin gönderdiği belgeyi kaydet — Yüklenen dosyayı, gönderildiği belgeye karşılık potansiyel müşteriye ekler.

Gereken izin lead_documents:write · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır)

• Asıl adres: POST /api/v1/actions/lead_documents.submit

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: lead_documents.submitted

Neye yazar: lead_document (insert) — Files the document; lead_document_link (update) — Stamps when the link was last used

curl -X POST https://app.getera.io/api/v1/lead_documents/actions/submit \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"token":"Link token","requestId":"LEAD_DOCUMENT_REQUEST_ID","fileId":"FILE_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "lead_documents.submitted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.leadDocuments.submit({
  token: "Link token",
  requestId: "LEAD_DOCUMENT_REQUEST_ID",
  fileId: "FILE_ID"
})

era lead_documents submit \
  --token "Link token" \
  --request-id "LEAD_DOCUMENT_REQUEST_ID" \
  --file-id "FILE_ID"

{
  "name": "era__lead_documents__submit",
  "arguments": {
    "token": "Link token",
    "requestId": "LEAD_DOCUMENT_REQUEST_ID",
    "fileId": "FILE_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde lead_documents:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 link_unknown, link_expired, request_not_on_link, file_not_found · 429 çok sık istek

Veri modelleri

LeadDocumentLink

Tablo lead_document_link · Kaynak lead_document_links

• GET /api/v1/lead_document_links
• GET /api/v1/lead_document_links/{id}

Birincil anahtar: id

LeadDocumentRequest

Tablo lead_document_request · Kaynak lead_document_requests

• GET /api/v1/lead_document_requests
• GET /api/v1/lead_document_requests/{id}

Birincil anahtar: id

Denetimler:

• CHECK ((max_file_size_mb > 0))

LeadDocument

Tablo lead_document · Kaynak lead_documents

• GET /api/v1/lead_documents
• GET /api/v1/lead_documents/{id}

Birincil anahtar: id

Olaylar

İş akışları ve webhook'lar bu olaylara tepki verir.