Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
btrz-api-client
Advanced tools
Readme
function all({ token, query, [jwtToken] }): Returns all resources
function get({ token, id.[jwtToken] }): Returns one resource
function create({jwtToken, token, resource }): Creates a new resource
function update({jwtToken, token, id, resource}): Updates a resource with the given id
function remove({jwtToken token, id }): Remove the resource
jwtToken
Is only required in certain endpoints, check the endpoint documentation.
const api = require("btrz-api-client").createApiClient({ baseURL: `http://localhost:${port}` });
api.inventory.products.all({ token, query }) => Promise
const api = require("btrz-api-client").createApiClient({ baseURL: 'http://localhost:8080', });
api._cleanClient({ url: `/inventory/products`, headers: { 'x-api-key': token }, params: { isParcel: true } }) => Promise
This client uses production defaults if none provided, check
/src/productionDefaults.js
const api = require("btrz-api-client").createApiClient();
api.inventory.products.all({ token, query }) //you're now talking to production!
Provide an object that generates internal auth tokens when you create the API Client:
const InternalAuthTokenProvider = require("btrz-auth-api-key").InternalAuthTokenProvider,
tokenProviderOptions = {
internalAuthTokenSigningSecrets: {
main: "<some_secret_signing_key>"
}
},
internalAuthTokenProvider = new InternalAuthTokenProvider(tokenProviderOptions),
ApiClient = require("btrz-api-client"),
apiClient = ApiClient.createApiClient({
internalAuthTokenProvider,
// ... plus any other options
});
Then, to perform a service-to-service call with an auto-generated token:
const apiRequest = apiClient.operations.manifest.getOrCreate({
token: <user_api_key>,
jwtToken: "internal_auth_token", // Use this exact string
query: {
...
}
});
npm test
API_TOKEN=<some token> npm run test:integration
You can specify the different ports for every endpoint using
/test-integration/ports.js
- src
- enpoints
- inventory
- products.js
- test
- endpoints
- inventory
- products.test.js
- test-integration
- endpoints
- inventory
- products.test.js
Run
npm version [major || minor || patch]
This will increment the version number according to your selection (major, minor or patch) and push a new TAG. There's no need to release a new version in the github UI.
FAQs
Api client for Betterez endpoints
The npm package btrz-api-client receives a total of 446 weekly downloads. As such, btrz-api-client popularity was classified as not popular.
We found that btrz-api-client demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.