Versioning
How the API is versioned today and which parts you can rely on.
There is one version of the API and it has no version in its URLs. Paths start at https://manage.corefinity.com/api.
What stays the same
| Part | Rule |
|---|---|
Refusal reason codes | A code keeps its meaning. code always equals reason |
invalid and invalid_arguments | Both mean a field that is missing or wrong; treat them alike |
| Scope names | read, write, exec, destructive |
Writing a client that keeps working
| Do | Because |
|---|---|
| Ignore fields you do not know | Answers gain fields as features are added |
Branch on reason, never on message | Messages are for people and can be reworded |
Treat an unknown status or reason as not finished or refused | New values can appear |
Expect 404 feature_off | A feature can be off for your company |
Features that are off
An endpoint whose feature is not on for your company answers 404 with reason: feature_off. It is documented here only once the feature is available.
Was this helpful?