Endpointy API

CRUD operace

Čtení záznamu (GET)

GET /api/v1/{entityType}/{id}

Parametry:

Parametr	Typ	Popis
entityType	string	Typ entity (Contact, Account...)
id	string	ID záznamu

Odpověď:

{
  "id": "123abc",
  "name": "Jan Novák",
  "emailAddress": "jan@example.com",
  "phoneNumber": "+420123456789",
  "createdAt": "2024-01-15T10:30:00+01:00",
  "modifiedAt": "2024-01-20T14:45:00+01:00"
}

Seznam záznamů (GET)

GET /api/v1/{entityType}

Query parametry:

Parametr	Typ	Popis	Příklad
select	string	Pole k vrácení	select=id,name,email
where	array	Filtrační podmínky	where[0][type]=equals&where[0][attribute]=status&where[0][value]=Active
orderBy	string	Řazení	orderBy=createdAt
order	string	Směr řazení	order=desc
offset	integer	Počáteční pozice	offset=0
maxSize	integer	Max. počet záznamů	maxSize=50

Odpověď:

{
  "total": 150,
  "list": [
    {
      "id": "123abc",
      "name": "Jan Novák"
    },
    {
      "id": "456def",
      "name": "Marie Svobodová"
    }
  ]
}

Vytvoření záznamu (POST)

POST /api/v1/{entityType}

Tělo požadavku:

{
  "name": "Jan Novák",
  "emailAddress": "jan@example.com",
  "phoneNumber": "+420123456789",
  "accountId": "acc123"
}

Odpověď:

{
  "id": "789ghi",
  "name": "Jan Novák",
  "emailAddress": "jan@example.com",
  "createdAt": "2024-01-25T09:00:00+01:00"
}

Aktualizace záznamu (PUT)

PUT /api/v1/{entityType}/{id}

Tělo požadavku:

{
  "phoneNumber": "+420987654321",
  "description": "Aktualizovaný popis"
}

Smazání záznamu (DELETE)

DELETE /api/v1/{entityType}/{id}

Odpověď: 200 OK (prázdné tělo)

Vztahy

Seznam souvisejících záznamů

GET /api/v1/{entityType}/{id}/{link}

Příklad:

GET /api/v1/Account/123/contacts

Propojení záznamů

POST /api/v1/{entityType}/{id}/{link}

Tělo požadavku:

{
  "id": "contact456"
}

Odpojení záznamů

DELETE /api/v1/{entityType}/{id}/{link}

Query parametr:

?id=contact456

Hromadné operace

Hromadný update

PUT /api/v1/{entityType}/action/massUpdate

Tělo požadavku:

{
  "ids": ["id1", "id2", "id3"],
  "attributes": {
    "status": "Active",
    "assignedUserId": "user123"
  }
}

Hromadné smazání

POST /api/v1/{entityType}/action/massDelete

Tělo požadavku:

{
  "ids": ["id1", "id2", "id3"]
}

Speciální akce

Konverze leadu

POST /api/v1/Lead/{id}/action/convert

Tělo požadavku:

{
  "records": {
    "Account": {
      "name": "Nová firma"
    },
    "Contact": {
      "firstName": "Jan",
      "lastName": "Novák"
    },
    "Opportunity": {
      "name": "Nová příležitost",
      "amount": 100000
    }
  }
}

Odeslání emailu

POST /api/v1/Email

Tělo požadavku:

{
  "to": "recipient@example.com",
  "subject": "Předmět emailu",
  "body": "<p>Obsah emailu v HTML</p>",
  "isHtml": true,
  "parentType": "Contact",
  "parentId": "contact123"
}

---