Datamodell

Att förstå hur entiteter relaterar till varandra är avgörande för effektiv API-integration. Diagrammet nedan illustrerar dessa relationer och kan hjälpa dig:

• Identifiera vilka entiteter du behöver arbeta med för ditt användningsfall
• Förstå databeroenden (t.ex. ett Case kräver en Customer och kan innehålla flera Invoices)
• Navigera ägarhierarkier (t.ex. Creditors som tillhör antingen Partners eller Accounts)
• Planera ditt integrationsarbetsflöde

Entitetsrelationsdiagram

Notera Partner-entiteten är endast tillgänglig för partners

API User Notera En API-användare är en standard User som autentiserar med en public_key och är medlem i api_user access group, vilket ger API-specifika behörigheter. För direkta API-integrationer använder Account en sådan användare. För partnerledda integrationer använder Partner en sådan användare; Accounts under den partnern har vanligtvis inte sin egen API-användare.

Relationstyper

Diagrammet använder standard ER-notation för att visa relationer mellan entiteter:

Kardinalitet

Relationerna använder crow's foot-notation för att visa kardinalitet:

• ||--|| : Exakt en till exakt en
• ||--|{ : Exakt en till noll eller många
• ||--o| : Exakt en till noll eller en
• }|--|{ : Noll eller många till noll eller många

Till exempel:

• ACCOUNT ||--|{ CREDITOR : owns
  • Varje Account måste äga en eller flera Creditors
  • Varje Creditor måste tillhöra exakt ett Account

Access Group

Access Groups definierar behörigheter och dataåtkomstomfattningar för användare inom ett Account. Varje Account kan definiera flera Access Groups, och användare kan vara medlemmar i flera Access Groups. api_user access group är en speciell grupp som ger API-specifika behörigheter för programmatisk åtkomst.

Nyckelrelationer:

• ACCOUNT ||--|{ ACCESSGROUP : defines - Varje Account definierar sina egna Access Groups
• ACCESSGROUP }|--|{ USER : members - Användare kan tillhöra flera Access Groups

För API-integrationsdetaljer, se Account creation endpoint, Access Group listing, och User creation.

User

Users representerar individer eller systemkonton som kan komma åt plattformen. En User inkluderar autentiseringsdata, e-postinformation och dataåtkomstbehörigheter. För API-åtkomst autentiserar användare med en public_key och måste vara medlemmar i api_user access group för att få API-specifika behörigheter.