How it works
- myAbode registers your application and the scopes it needs.
- myAbode issues you an application key. It starts with
myapp_. - Each brokerage that wants to use your product grants your application access.
- Your key reads every brokerage that has granted access, with the application’s scopes. Use the
brokeragefilter on the deals, tasks, users, offices and events lists to narrow to one. On the users list the filter only chooses which users come back: each user still lists their memberships in every brokerage your key can read.
What changes take effect immediately
Access is checked on every request:- A brokerage that removes its grant drops out of your results on the next call.
- If myAbode disables an application, all of its keys stop working at once. Re-enabling it restores the existing grants and keys.
- A brokerage that leaves myAbode stops appearing.