{"ref":"artifact:sapmentors-cds-scp-api","page":"/artifacts/sapmentors-cds-scp-api","json":"/artifacts/sapmentors-cds-scp-api.json","generated":"2026-10-26","drafted_with_ai":true,"entity":{"id":"sapmentors-cds-scp-api","name":"@sapmentors/cds-scp-api","artifact_type":"package","ecosystem":"cap","flavors":[{"key":"node","source":{"url":"https://raw.githubusercontent.com/sapmentors/cds-scp-api/master/README.md","title":"CDS-SCP-API Node Module — README, CDS Extension for SAP Cloud Platform API Consumption","checked":"2026-10-19","quote":"The node module CDS-SCP-API simplifies the consuming external API from SAP OnPremise & Cloud APIs, Microsoft Office 365 APIs, Google Cloud Platform APIs, and other REST APIs in a Cloud Application Programming (CAP) Model on the SAP Cloud Platform."}}],"domain":"integration-and-messaging","origin_ring":"community-org","description":{"one_line":"A Node module for CAP that calls an external API through a destination instead of a hardcoded endpoint, taking its address, credentials and on-premise tunnel from the SAP Destination and Connectivity services.","short":"Node module for CAP calling external APIs through a destination","what_it_solves":"Calling an API outside the application means holding its address, its credentials and, for an on-premise system, a tunnel. This module takes all three from the [SAP Destination service](artifact:btp-destination) and the [SAP Connectivity service](artifact:btp-connectivity) instead: `cdsapi.connect.to(\"ES5\")` resolves a destination by name, and `service.run({ url: \"/pathOfService\" })` issues the request against a URL relative to it. The request options are those of [axios](external:axios), minus the ones the module takes from the destination, which its README names as authentication, the proxy settings and the baseURL; `csrfProtection: true` is the setting the README adds to a request that needs an X-CSRF token. The README lists the destination types it covers: internet destinations with no authentication, with basic authentication, with client credentials including Microsoft Azure and with JWT for Google Cloud Platform, plus on-premise destinations through the [Cloud Connector](artifact:sap-cloud-connector) with no authentication or with basic authentication.","when_not_to_use":"The package declares `@sap/cds` ^4.5.2 among its dependencies and pins `@sap-cloud-sdk/core` at 1.37.1, so a project on CAP 5 or later is outside the range it states."},"links":{"npm":"https://www.npmjs.com/package/@sapmentors/cds-scp-api","repo":"https://github.com/sapmentors/cds-scp-api"},"identity":{"author":"SAP Mentors & Friends","license":"MIT"},"compat":{"runtimes":["node"],"cds_range":"^4.5.2"},"type_properties":{"placement":{"value":"in-host","sources":[{"url":"https://raw.githubusercontent.com/sapmentors/cds-scp-api/master/README.md","title":"CDS-SCP-API Node Module — README, Javascript/Node.js Code","checked":"2026-10-19","quote":"// Load the module\nconst cdsapi = require(\"cds-scp-api\");"}]},"distribution":{"value":["npm"],"sources":[{"url":"https://raw.githubusercontent.com/sapmentors/cds-scp-api/master/README.md","title":"CDS-SCP-API Node Module — README, Installation","checked":"2026-10-19","quote":"npm install @sapmentors/cds-scp-api"}]}},"provides":[{"capability":"capability:destinations","what_it_does":"Resolves a destination by name from the CAP service and makes the call against it, so the endpoint, the credentials and the on-premise tunnel stay in the destination configuration.","sources":[{"url":"https://raw.githubusercontent.com/sapmentors/cds-scp-api/master/README.md","title":"CDS-SCP-API Node Module — README, what the module provides","checked":"2026-10-19","quote":"Endpoint and Configuration using SAP Cloud Platform Destination and Connectivity services"},{"url":"https://raw.githubusercontent.com/sapmentors/cds-scp-api/master/README.md","title":"CDS-SCP-API Node Module — README, Compare Axios with CDS-SCP-API","checked":"2026-10-19","quote":"CDS-SCP-API implementation uses relative URLs, and authorization is configured in the SAP Cloud Platform and handled by the CDS-SCP-API implementation."}]}],"requires":[{"ref":"artifact:btp-destination","for":"Holds the endpoint and the credentials the module resolves by name before it issues the request.","requirement":"required","sources":[{"url":"https://raw.githubusercontent.com/sapmentors/cds-scp-api/master/README.md","title":"CDS-SCP-API Node Module — README, what the module provides","checked":"2026-10-19","quote":"Endpoint and Configuration using SAP Cloud Platform Destination and Connectivity services"}]},{"ref":"artifact:btp-connectivity","for":"Carries the request to a system behind the [Cloud Connector](artifact:sap-cloud-connector) rather than to one reachable over the internet.","requirement":"conditional","condition":"the destination is an on-premise one reached through the Cloud Connector","sources":[{"url":"https://raw.githubusercontent.com/sapmentors/cds-scp-api/master/README.md","title":"CDS-SCP-API Node Module — README, Supported Destination Types","checked":"2026-10-19","quote":"OnPremise Destination and Connectivity via Cloud Connector with No Authentication"}]},{"ref":"external:axios","for":"The request options are Axios config options, and the module is written as a layer over it.","requirement":"required","sources":[{"url":"https://raw.githubusercontent.com/sapmentors/cds-scp-api/master/README.md","title":"CDS-SCP-API Node Module — README, CDS-SCP-API Config Settings","checked":"2026-10-19","quote":"The CDS-SCP-API is an SAP Cloud Platform layer on top of Axios."}]}],"connects":[{"ref":"artifact:btp-destination","kind":"data","direction":"outbound","for":"Reads the authentication, the proxy settings and the baseURL of the named destination, which is why the call site writes a relative URL.","sources":[{"url":"https://raw.githubusercontent.com/sapmentors/cds-scp-api/master/README.md","title":"CDS-SCP-API Node Module — README, CDS-SCP-API Config Settings","checked":"2026-10-19","quote":"CDS-SCP-API will ignore the Axios config settings for the authentification, the proxy settings, and the baseURL. The CDS-SCP-API retrieves these settings from the SAP Cloud Platform Destination & Connectivity services."}]},{"ref":"artifact:btp-connectivity","kind":"data","direction":"outbound","condition":"the destination is an on-premise one reached through the Cloud Connector","for":"The other service the module reads its connection settings from, for a destination that goes to an on-premise system.","sources":[{"url":"https://raw.githubusercontent.com/sapmentors/cds-scp-api/master/README.md","title":"CDS-SCP-API Node Module — README, CDS-SCP-API Config Settings","checked":"2026-10-19","quote":"The CDS-SCP-API retrieves these settings from the SAP Cloud Platform Destination & Connectivity services."},{"url":"https://raw.githubusercontent.com/sapmentors/cds-scp-api/master/README.md","title":"CDS-SCP-API Node Module — README, Supported Destination Types","checked":"2026-10-19","quote":"OnPremise Destinations and Connectivity via Cloud Connector with Basic Authentication"}]}],"maintainers":["actor:gregorwolf","actor:sapmentors","actor:vobu"],"provenance":{"discovered_via":[{"source":"source:npm"}],"first_seen":"2026-09-20"},"drafted_with_ai":true,"contributors":["actor:edob","actor:gregorwolf","actor:raeijpe"]},"effective_normative_relations":[],"readings":{"liveness":[{"label":"Maintenance","tier":"poor","evidence":"68 months since release"},{"label":"Continuity","tier":"good","evidence":"3 contributors, 2 publishers, org-owned"},{"label":"Repository","tier":"poor","evidence":"pushed 2022-01, not archived"}],"compatibility":[{"label":"Declared for","tier":"poor","evidence":"^4.5.2 — stops before cds 9"},{"label":"Survived majors","tier":"poor","evidence":"no release since @sap/cds 10 shipped (July 2026)"},{"label":"Maintainer's CI","tier":"fair","evidence":"workflows present, no completed run on the default branch"}],"practice":[{"label":"Tests","tier":"good","evidence":"5 test files, npm test"},{"label":"Docs","tier":"good","evidence":"docs/ with 6 pages, README 5 KB"},{"label":"Changelog","tier":"good","evidence":"CHANGELOG in the repo"}],"reach":[{"value":9,"unit":"installs/week","note":"More people watching than installing — noticed deliberately rather than pulled in."},{"value":15,"unit":"watching"}]},"signals":{"crawled_at":"2026-10-25","latest_version":"1.0.4","majors":{"1":{"version":"1.0.3","date":"2021-02-18"}},"license":"MIT","first_release":"2021-02-18","last_release":"2021-02-18","releases":2,"cadence_days":null,"maintainers":2,"repository":"git://github.com/sapmentors/cds-scp-api.git","repository_directory":null,"peer_cds":null,"dependencies":8,"node_engine":null,"test_script":true,"types":false,"downloads_weekly":9,"downloads_monthly":84,"stars":15,"forks":5,"open_issues":6,"archived":false,"pushed_at":"2022-01-03","license_spdx":"MIT","org_owned":true,"default_branch":"main","created_at":"2020-10-06T14:35:20Z","open_prs":1,"tree_truncated":false,"test_files":5,"workflows":1,"other_ci":false,"readme_bytes":5383,"docs_files":6,"changelog":true,"license_file":true,"dts_files":0,"first_commit":"2020-10-06","last_commit":"2022-01-03","commits":82,"contributors":3,"readme_path":"README.md","readme_sha":"4303a43869d0b3ac66b20de59478819352d5e521","months_since_release":68,"dormant":true,"repo_read":"2026-10-25"},"release_notes":{"license":"MIT","quotable":true,"source":{"kind":"npm","path":"CHANGELOG.md","version":"1.0.4","url":"https://github.com/sapmentors/cds-scp-api/blob/main/CHANGELOG.md"},"format":"headings","releases":[{"version":"1.0.4","date":"2021-02-18","date_source":"heading","heading":"1.0.4 (2021-02-18)","url":"https://github.com/sapmentors/cds-scp-api/blob/main/CHANGELOG.md#104-2021-02-18","sections":[],"hash":"e3b0c44298fc1c14"},{"version":"1.0.3","date":"2021-02-18","date_source":"heading","heading":"1.0.3 (2021-02-18)","url":"https://github.com/sapmentors/cds-scp-api/blob/main/CHANGELOG.md#103-2021-02-18","sections":[],"hash":"e3b0c44298fc1c14"},{"version":"1.0.2","date":"2021-02-18","date_source":"heading","heading":"1.0.2 (2021-02-18)","url":"https://github.com/sapmentors/cds-scp-api/blob/main/CHANGELOG.md#102-2021-02-18","sections":[],"hash":"e3b0c44298fc1c14"},{"version":"1.0.1","date":"2021-02-18","date_source":"heading","heading":"1.0.1 (2021-02-18)","url":"https://github.com/sapmentors/cds-scp-api/blob/main/CHANGELOG.md#101-2021-02-18","sections":[],"hash":"e3b0c44298fc1c14"}],"versions":[{"version":"1.0.4","date":"2021-02-18"},{"version":"1.0.3","date":"2021-02-18"}],"crawled_at":"2026-10-25"},"edges":{"maintainers":[{"ref":"actor:gregorwolf","name":"Gregor Wolf","json":"/actors/gregorwolf.json"},{"ref":"actor:sapmentors","name":"SAP Mentors & Friends","json":"/actors/sapmentors.json"},{"ref":"actor:vobu","name":"Volker Buzek","json":"/actors/vobu.json"}],"contributors":[{"ref":"actor:edob","name":"EdoB","json":"/actors/edob.json"},{"ref":"actor:gregorwolf","name":"Gregor Wolf","json":"/actors/gregorwolf.json"},{"ref":"actor:raeijpe","name":"Robert Eijpe","json":"/actors/raeijpe.json"}],"explained_by":[],"alternative_to_this":[],"needed_by":[],"available_via":[],"parts":[],"add_ons":[],"answered_through_parts":[]}}