# dhl-api

> The RIPE DHL API client

Latest version **0.6.2** (published 2022-04-08) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install dhl-api
pnpm add dhl-api
yarn add dhl-api
bun add dhl-api
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.2 |
| Published | 2022-04-08 |
| First published | 2022-01-20 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 618.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Platforme |
| Maintainers | platforme |
| Keywords | api, client, dhl, js |

## Links

- npm: https://www.npmjs.com/package/dhl-api
- Repository: https://github.com/ripe-tech/dhl-api-js
- Homepage: https://github.com/ripe-tech/dhl-api-js#readme
- Issues: https://github.com/ripe-tech/dhl-api-js/issues
- npm.io page: https://npm.io/package/dhl-api

## Dependencies (1)

- [yonius](https://npm.io/package/yonius.md) ^0.6.5

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.6.2 (latest) — 2022-04-08
- 0.6.1 — 2022-03-04
- 0.6.0 — 2022-02-28
- 0.5.0 — 2022-02-12
- 0.4.0 — 2022-02-04
- 0.3.0 — 2022-02-01
- 0.2.0 — 2022-01-24
- 0.1.0 — 2022-01-20

## README

# DHL API for Javascript

The DHL API Javascript client implementation.

```javascript
const dhlAPI = require("dhl-api");

// instance the API client with defaults
const dhl = new dhlApi.API({
    username: "mydhlaccount",
    password: "mydhlaccountpassword",
});

// example: request tracking information
const tracking = await api.getTracking("7798339175");
```

## Configuration

| Name             | Type  | Default                                 | Description                                                    |
| ---------------- | ----- | --------------------------------------- | -------------------------------------------------------------- |
| **DHL_BASE_URL** | `str` | `https://express.api.dhl.com/mydhlapi/` | The base URL that is going to be used for DHL API connections. |
| **DHL_USERNAME** | `str` | `None`                                  | The DHL API username to be used for authentication             |
| **DHL_PASSWORD** | `str` | `None`                                  | The DHL API password to be used for authentication             |

## License

DHL API for Javascript is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).

## Build Automation

[![Build Status](https://app.travis-ci.com/ripe-tech/dhl-api-js.svg?branch=master)](https://travis-ci.com/github/ripe-tech/dhl-api-js)
[![Build Status GitHub](https://github.com/ripe-tech/dhl-api-js/workflows/Main%20Workflow/badge.svg)](https://github.com/ripe-tech/dhl-api-js/actions)
[![npm Status](https://img.shields.io/npm/v/dhl-api.svg)](https://www.npmjs.com/package/dhl-api)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://www.apache.org/licenses/)

---
_Source: https://npm.io/package/dhl-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._