Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

This introduction is written based on experience drawn from a lot of custom integrations. It is aimed at consultants implementing an integration for a BRP-customer.

An API-integration with BRP is a very complex task, not in a technical sense but the domain knowledge required for a successful end result is substantial. As a consultant you will have to spend a lot of time in cooperation with your client's BRP-users to gain a full understanding of the system and how it is used.
BRP is a standard system and very generic. It can be configured in a multitude of ways. BRP Support does not have knowledge of how a specific customer uses BRP.

Every integration project must have these three roles defined before even starting:
* A project leader representing the BRP-customer
* A project leader representing the consultant
* A project leader from BRP

BRP will debit the hours spent on the project.

There is a monthly fee for write access to the API (POST, PUT, DELETE). Read access is free.

Brponly
TitleÄrendeinformation

Utvecklare som webteamet utser hamnar som CC på ärendet för direktkontakt.

 

Brponly
TitleReverse proxy

Ligger webservern bakom en reverse proxy så krävs det att reverse proxyn sätter en http-header med vilken ip-adress som anropet kommer ifrån. Inställningen 'ipHeaderReverseProxy' måste då sättas för att servern ska veta vilken header som den ska titta på. Vanligast är att den kallas: "X-Forwarded-For". Om headern förväntas innehålla någonting mer komplicerat än bara en vanlig IP-address så kan det behövas en uppdatering, eftersom vårat stöd för rfc7239 inte är speciellt robust.

Glöm inte att köra about.gsp för att gogen ska läsa om inställningarna.

...

Word

Definition

Comments

activitybooking

Class booking

Class booking and waiting list

purchase

Purchase

Purchase of services, events, goods, subscriptions, value cards and deals

person

User/booker

 

resource

Resource

Rooms, instructors, staff, equipment etc.

activity

Group activity/class

 

event

Event

Events such as speaches, courses

order

Order

Completed order, either paid or confirmed

bokning

Booking

Based on type of product: service, goods, subscription, valuecard and deal

receipt

Receipt

 

item

Order row or receipt row

 

timeslotsuggestions

Suggested time for service booking

 

Error management

Error codes

Brponly
TitleFelsökning

Error management

Error management[BRP Only] Reading apirequestlog

Common methods

Examples of common methods

Side effects and limitations for purchases and bookings

Side effects and limitations for purchases and bookings

Rest objects
Anchor
Restobject
Restobject

 

Create

Modify

List

Delete

Requires log on

Extra information about API key level 3Level 3 person ID

subscriptions

 

X

X1

X1

X

 userid

businessunits

 

 

X

 

 

  

events

 

X

X

 

 

Use 3rd level API key for eventsevents (Level 3 API Key)personid3

eventbookings

 

X

X

 

X

Use 3rd level API key for eventbookingseventbookings (Level 3 API Key)personid
autogiromedgivandenXXX X personid
avtalegirosX X X personid
generateregisteravtalegirolinkX   X personid
generateapi3tokenX   X personid
documentdata  X X personid

invoices

X

 

X*

 

X

 orderedbyid

activities

 

 

X

 

 

 personid3

groupactivitybookings

X1

 

X

X1

X

 personid
groupActivityInstructors  X    
owndefinedparameters  X    
passagetriesX     personid
cardreaders  X    

products

 

 

X

 

 

  

messages

 

 

X

 

 

  

noshow

  X   personid

persons

X2

X1

X

 

X

Using level 3 keys for personspersonid

productgroups

 

 

X

 

 

  

orders

X1

X1

X1

X1

X

Using level 3 keys for ordersorderedbyid
organizations (Level 3 API Key)XXX    

items

X1

 

 

X1

X

  

resources

 

 

X

 

 

  
bookingtimesuggestions  X    

timeslotsuggestions

Deprecated from version 1.623.

Use bookingtimesuggestions instead.

 

 

X

 

 

  

productlabels

 

 

X

 

 

  

resourcetypes

 

 

X

 

 

  
receiptsX X X customerid

workouts

 

 

X

 

X

Using level 3 keys for workoutspersonid

servicebookings

 

 

X

 

X

 personid
valuecards  X1 X customerid
prices  X    
signaturesX      
personlookup (Level 3 API Key)  X  Requires level 3 key 
paymentcertificates  X   personid
scheduledtimes  X    
participantsXXXX  personid
persongroups  X    
organizationgroups  X    

1With a 3rd level API key a particular person kan be identified by using that persons ID. The ID has depending on what you are attempting to access, for example a person or a subscription:

...