Maintaining listing data
These guides walk partners through every task needed to create and maintain listing data for their customers with the Markee API. Each guide groups one scenario, explains the steps in order and links to the endpoints you need.
All guides use the Markee API. Authenticate first as described in Authentication methods.
Recommended order
| # | Guide | Use it to |
|---|---|---|
| 1 | Companies and locations | Create, update and remove companies and locations |
| 2 | Location profile data | Maintain phones, opening hours, categories, media and Google attributes |
| 3 | Subscriptions | Book, inspect, change and cancel listing products |
| 4 | Enhanced Content Lists | Manage menus, products and services, events and profiles |
| 5 | Social profile connections | Connect Google, Facebook and LinkedIn profiles |
| 6 | Reviews and social posts | Read and answer reviews, publish posts |
| 7 | Analytics | Retrieve statistics for locations and subscriptions |
| 8 | Duplicates and listing state | Handle duplicate listings and portal opt-in/out |
| 9 | Testing and go-live | Verify your integration in the sandbox before going live |
Environments
| Environment | API base URL |
|---|---|
| Sandbox | https://qa-api.mark.ee/api |
| Production | https://api.mark.ee/api |
Build and test everything against the sandbox first. See Testing and go-live.
Identifiers
Most endpoints take an id in the path. Its meaning depends on the endpoint, so check which entity is expected.
| Entity | Obtained from | Used by |
|---|---|---|
| Workspace ID | Provided during onboarding | POST /company/{id}, GET /company |
| Company ID | POST Company | Locations, contracts, enhanced content |
| Location ID | POST Location | Profile data, subscriptions, listings, reviews |
| Contract ID | GET Contract list | Licences |
| Licence ID | GET Licence list | POST /subscription/{id} |
| Subscription ID | POST Subscription | Subscription changes, statistics |
Conventions
- Create and update calls return a
Successobject. For creates,valueholds the new ID. Store it. - Lists are paginated with
skip/take(takeis at most 500 where stated) orafter/beforefor companies. - Phone numbers can be sent in any common format, for example
+49 911 123456or0911 123456. Without an international country code, Germany is assumed. - Errors are returned as an
Errorobject witherrorCode,errorMessageand, where applicable, the affectedfields. Log the full object.