LKAB API Catalog
This is a registry of all published APIs.
All APIs published to the LKAB API Management SHOULD
have a unique id and basepath.
API basepath
The API basepaths are globally unique within the API Management platform. To avoid collisions, the basepath assigned to an API published to the LKAB API Management platform, need to conform with the pre-defined set of basepaths in the Pre-defined basepaths document, and be unique within the API Catalog table below.
Assignement of API basepath is part of the onboarding process when a new API are about to be published to the API Management platform, agreed upon between API owner and the API Management team.
The agreed and assigned API basepath SHOULD
be documented along with the assigned API Id in this document before first deployment.
Changes to the API basepath SHOULD
be discussed and agreed with the API Management team, and then documented in this document before re-deployment.
When the need for new basepaths emerges, always document the new basepath in the Pre-defined basepaths document.
API Id
All APIs SHOULD
have a unique id. To get a new API Id, reserve the next id in the serial number when adding a new line in the catalog table below.
Pattern: [api[0-9]{4}-[a-z0-9-]
, Ex. api9999-lkab-test
API Catalog
Register an API by adding a new row at the bottom of the table. Reserve a unique API Id by incrementing the serial number and choose a unique basepath according to instructions above.
To edit this page you need to clone the documentation GIT repository, create a feature branch, edit the file API-catalog.md, commit, push and create a Pull Request into the main branch.
API Id | API basepath | Source |
---|---|---|
api0001-boomi-outbound-coupa |
/internal/boomi/coupa |
Integrations Boomi - api0001-boomi-outbound-coupa |
api0002-boomi-outbound-ifs |
/internal/boomi/ifs |
Integrations Boomi - api0002-boomi-outbound-ifs |
api0003-boomi-outbound-maximo |
/internal/boomi/maximo |
Integrations Boomi - api0003-boomi-outbound-maximo |
api0004-boomi-outbound-workday |
/internal/boomi/workday |
Integrations Boomi - api0004-boomi-outbound-workday |
api0005-goods-receipt |
/integration/purchasetopay/goodsreceipt |
Integrations Boomi - api0005-goods-receipt |
api0006-items |
/integration/masterdata/items |
Integrations Boomi - api0006-items |
api0008-maintenance |
/integration/maintenance |
Integrations Boomi - api0008-maintenance |
api0009-order-to-cash |
/integration/ordertocash |
Integrations Boomi - api0009-order-to-cash |
api0010-purchase-requisition |
/integration/purchasetopay/requisition |
Integrations Boomi - api0010-purchase-requisition |
api0011-plant-register |
/integration/plant-register |
Integrations Boomi - api0011-plant-register |
api0012-storefront |
/integration/purchasetopay/storefront |
Integrations Boomi - api0012-storefront |
api0013-supplier |
/integration/masterdata/supplier |
Integrations Boomi - api0013-supplier |
api0014-supplier-invoice |
/integration/purchasetopay/supplier-invoice |
Integrations Boomi - api0014-supplier-invoice |
api0015-supply |
/integration/purchasetopay/supply |
Integrations Boomi - api0015-supply |
api0016-boomi-test-automations |
/boomi/test-automation |
Integrations Boomi - api0016-boomi-test-automations |
api0017-boomi-outbound-weland |
/internal/boomi/weland |
Integrations Boomi - api0017-boomi-outbound-welanda |
api0018-lkab-production-read |
TBD | TBD |
api0019-epiroc-certiq-kiruna |
/external/epiroc/certiq/kiruna |
Epiroc Certiq - api0019-epiroc-certiq-kiruna |
api0020-epiroc-certiq-malmberget |
/external/epiroc/certiq/malmberget |
Epiroc Certiq - api0020-epiroc-certiq-malmberget |
api0021-sandvik-optimine |
/external/sandvik/optimine |
api0021 |
api0022-lkab-ip21 |
/sensor-data/ip21 |
LKAB IP21 - api0022-lkab-ip21 |
api0023-boomi-outbound-ip21 |
/internal/boomi/ip21 |
Integrations Boomi - api0023-boomi-outbound-ip21 |
api0024-telia-service-desk-plus |
/integration/sdplus |
api0024 |
api0025-lkab-logistics-rfid-sitestatus |
/logistics/railway/sites |
api0025 |
api0026-lkab-reinforcement |
/internal/giron/omforstarkning |
api0026 |
api0027-plantvision-abs |
/maintenance/plantvision/abs |
api0027 |
api0028-lkab-arena-webapi |
/communications/arena |
api0028 |
api0029-lkab-mine-lifecycle-management |
/mining/development/mlm |
api0029 |
api0031-boomi-outbound-boomi |
/internal/boomi/boomi |
Integrations Boomi - api0031-boomi-outbound-boomi |
api0032-epiroc-certiq-cloud |
/external/epiroc/certiq/cloud |
api0032 |
api0035-lkab-cmdb |
/integration/cmdb |
api0035 |
api0036-lkab-mining-production-ring-info-v1 |
/mining/production/ring-info/v1 |
Giron - api0036-lkab-mining-production-ring-info-v1 |
api0037-lkab-mining-field-service-v1 |
/mining/support-functions/v1 |
Giron - api0037-lkab-mining-field-service-v1 |
api0038-lkab-mining-development-face-info-v1 |
/mining/development/face-info/v1 |
Giron - api0038-lkab-mining-development-face-info-v1 |
api0039-lkab-mining-production-loading-result-v1 |
/mining/production/loading/result/v1 |
Giron - api0039-lkab-mining-production-loading-result |
api0040-deswik-mining-design-figure-retrieval-kiruna |
/mining/design/figure-retrieval/kiruna |
api0040 |
api0041-deswik-mining-design-figure-retrieval-malmberget |
/mining/design/figure-retrieval/malmberget |
api0041 |
api0042-lkab-mining-exploration-drillhole |
/mining/exploration/drillhole |
api0042 |
api0043-lkab-asyncapi-portal |
/development/asyncapi |
api0043 |
api0044-green-cargo-ip21 |
/sensor-data/green-cargo |
api0044 |
api0045-epiroc-emi-kiruna |
/internal/epiroc/emi/kiruna |
api0045 |
api0046-lkab-mlm-collector |
/mining/development/mlm-collector |
api0046 |
api0047-lkab-mining-ore-pass |
/mining/ore-pass |
api0047 |
api0048-tvab-kiruna-ip21 |
/sensor-data/tvab-kiruna |
api0048 |
api0049-lkab-csw |
/internal/lkab/csw |
api0049 |
api0050-sjt-import |
/internal/sjt-import |
api0050 |
api0051-finance-treasury |
/finance/treasury |
|
api0052-lkab-mining-production-charging-mobile |
/internal/giron/production-charging-mobile |
api0052 |
api0053-boomi-outbound-medius |
/internal/boomi/medius |
api0053 |
api0054-purchase-order |
/integration/purchasetopay/purchaseorder |
api0054 |
api0055-railway-maintenance-workorders |
/logistics/railway/maintenance-workorders |
api0055 |
api0056-lkab-mining-ore-pass-balance-v1 |
/mining/ore-pass-balance/v1 |
Giron - api0056-lkab-mining-ore-pass-balance-v1 |
api0057-boomi-outbound-visma |
/internal/boomi/visma |
api0057 |
api0058-bizzdesign |
/integration/bizzdesign |
api0058 |
api0059-production-ledger |
/integration/production-ledger |
api0059 |
api0060-abb-edgenius-konsuln |
/integration/edgenius/konsuln |
|
api0061-volue-ip21 |
/sensor-data/volue |
api0061 |
api0062-supplier-payments |
/integration/purchasetopay/supplierpayments |
api0062 |
api0063-lbb-order-to-visma |
/internal/visma/lbb |
api0063 |
api0066-speclog-ip21 |
/sensor-data/speclog |
api0066 |
api0067-logistics-rubberwheel-transport |
/logistics/rubberwheel/transport |
api0067 |
api0069-lkab-mining-operational-compliance |
/mining/operational-compliance |
api0069 |
api0070-lkab-mining-production-area |
/mining/production-area |
api0070 |
api0072-lkab-mining-machine |
/mining/machine |
TBD |
api0073-hermx-edoc |
/integration/hermx/edoc |
api0073 |
api0074-medius |
/integration/medius |
api0074 |
api0075-digital-tvilling |
/internal/digital-tvilling |
api0075 |
api0077-ifs-business-dimension |
/integration/ifs/businessdimension |
TBD |
api0078-ifs-maintenance |
/integration/ifs/maintenance |
api0078 |
api0079-lkab-mining-production-loading |
/mining/production/loading |
api0079 |
api0080-lkab-sailpoint |
/internal/integration/identity |
api0080 |
api0081-lkab-mining-development |
/mining/development/ |
api0081 |
api0082-lkab-harbor |
/development/registry |
api0082 |
api0083-lkab-mining-production-charging |
/mining/production/charging |
api0083 |
api0084-resiot |
/sensor-data/resiot |
api0084 |
api0085-nordpool-dayahead |
/integration/nordpool/dayahead |
api0085 |
api0086-productionview |
/integration/productionview |
api0086 |
api0087-medius-reports |
/integration/medius/reports |
api0087 |
api0088-boomi-reprocessing |
/integration/boomi/reprocessing |
api0088 |
api0089-millistream-currency |
/finance/currency |
|
api0090-epiroc-emi-malmberget |
/internal/epiroc/emi/malmberget |
api0090 |
api0091-lkab-maximo |
/integration/maximo |
api0091 |
api0092-lkab-monitor |
/internal/monitor |
|
api0093-kjellin-leveaniemi |
/mining/leveaniemi/reports |
api0093 |
api0094-prism-management |
/internal/prism |
api0094 |
api0095-ifs-digitaltvilling |
/integration/ifs/digitaltvilling |
api0095 |
api0096-volvo-ip21 |
/sensor-data/volvo |
api0096 |
api0097-sitebase |
/internal/sitebase |
api0097 |
api0098-riksbanken-swea |
/finance/exchange-rates |
api0098 |
api0099-smartcalc |
/integration/smartcalc |
api0099 |
api0100-lkab-mining-loadingaggregator |
/mining/loadingaggregator |
TBD |
[api[0-9]{4}-[a-z0-9-] |
{api basepath} |
{link to git repo} |