npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mifiel/api-client-auth

v0.2.3

Published

Library to authenticate Mifiel API calls.

Downloads

210

Readme

@mifiel/api-client-auth

Library to authenticate Mifiel API calls. Mifiel uses SHA1 HMAC encryption.

Please read our documentation for instructions on how to start using the API. This library depends on axios to make requests to the Mifiel API.

Installation

npm install @mifiel/api-client-auth --save
# or
yarn add @mifiel/api-client-auth

Usage

For your convenience Mifiel offers a Sandbox environment where you can confidently test your code. To start using the API in the Sandbox environment you need to first create an account at sandbox.mifiel.com. Once you have an account you will need an APP_ID and an APP_SECRET which you can generate in https://app-sandbox.mifiel.com/settings/access-tokens.

Setting Tokens

// for ESM or TypeScript
import { Config } from '@mifiel/api-client-auth';
// for CJS
const { Config } = require('@mifiel/api-client-auth');

Config.setTokens({
  appId: '<APP_ID>',
  appSecret: '<APP_SECRET>',
  // [optional] - by default is production
  env: 'production' | 'sandbox' | 'staging'
});

Also, you can set the environment using the following methods:

// for sandbox use
Config.useSandbox();

// for production use
Config.useProduction();

Making a Request

Our Service.request method has 2 arguments: the first one is the resource name of the Mifiel API Rest and the second is the axios request config. It will return a promise.

Examples

import { Service } from '@mifiel/api-client-auth';

// GET /documents
const docs = await Service.request('documents', {
  method: 'GET',
});

// GET /documents/document-id
const doc = await Service.request('documents', {
  method: 'GET',
  url: 'document-id',
});

Also, we have a library to wrap the most common methods @mifiel/api-client