GET STARTED
Skip to main content

Quick start

The Device Recognition API uses advanced network device recognition to identify and classify devices on a network, providing structured JSON responses. Access to the API requires a valid Fing License Key.

Prerequisites

  • Internet Connection
  • Fing License Key: Obtain one by contacting sales@fing.com

Base API information

  • API Base URL: https://service.fing.com/3

Get started

  1. Obtain a License Key: Email sales@fing.com to get a development license key valid for 4 weeks.

  2. Authentication: Include the provided API Key in the HTTP header for all requests.

    X-API-KEY: [Your_API_Key_Here]

Make API calls

Recognize devices

curl -X POST "https://service.fing.com/3/devrecog" \
-H "Content-Type: application/json" \
-H "X-Api-Key: [Your_API_Key_Here]" \
-d '{ "devices" : [{ "mac" : "F0:98:9D:77:4C:13", "ip": "192.168.0.2", "state": "UP"}]}'

Retrieve device types

curl -X GET "https://service.fing.com/3/devicetypes" \
-H "Content-Type: application/json" \
-H "X-Api-Key: [Your_API_Key_Here]"

Important fingerprint information

MAC Address

  • What is it?: Unique identifier for network interfaces used in communications within a network segment.
  • Why it's important?: Essential for network hardware identification, used by Fing to match devices with known profiles.
  • How to retrieve it?: Capture via network packets, accessible through network interface configuration or ARP tables.

mDNS (Multicast DNS)

  • What is it?: A zero-configuration networking protocol that allows devices to resolve names to IP addresses within a local network.
  • Why it's important?: Enables easy discovery of devices on a local network without the need for a central DNS server.
  • How to retrieve it?: Send a multicast query to the local network segment and listen for responses that provide device names and services.

DHCP (Dynamic Host Configuration Protocol)

  • What is it?: A network management protocol used to automate the process of configuring devices on IP networks.
  • Why it's important?: Allows devices to receive an IP address and other network configuration details automatically, aiding in device identification.
  • How to retrieve it?: Monitor network traffic for DHCP packets that include options such as hostname and requested parameters, which can provide insights into the device's characteristics.

Testing tools

  • Command Line: Use curl or similar tools.
  • Graphical Interface: Use HTTP clients like Postman for more intuitive testing.

Support and further information

For more detailed information on endpoints, responses, and parameters, continue reading our documentation.