Skip to content

Amel #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Amel #36

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 32 additions & 41 deletions docs/Introduction.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,64 @@
# Meraki Dashboard API
# Introduction to Meraki Dashboard API

A RESTful API to programmatically manage and monitor Meraki networks at scale.
The Meraki Dashboard API (referred to as Meraki API) is a RESTful API interface that allows you to programmatically manage and monitor Meraki networks at scale.

<img src="../images/cloud-code.png" width="200px">

## What can you do with it?

- Add new organizations, admins, networks, devices, VLANs, and more
- Configure thousands of networks in minutes
- On-board and off-board new employees’ teleworker setup automatically
- Build your own dashboard for store managers, field techs, or unique use cases

Checkout out the [Explore](https://developer.cisco.com/meraki/explore/) section for open source projects, or browse the [Marketplace](https://apps.meraki.io/) for partner solutions.
Meraki APIs provide a range of operations to

## What's New in v1

The Dashboard API has evolved significantly, providing hundreds of operations to manage your Meraki networks!

We want to do so much more. But in order for us to include many of these new features or improvements, we need to break a few things.
- Add new organizations, administrators, networks, devices, VLANs, and more
- Configure thousands of networks in minutes
- On-board and Off-board new employees’ teleworker setup automatically, and
- Build custom dashboards for store managers, field technicians, or other unique use cases.

The focus of this **major** version is on **Simplicity** and **Scale**, by providing an enjoyable developer experience.

The API documentation, Postman collection, and Python library will remain synced and up-to-date with improved navigation and features.
Checkout out the [Explore](https://developer.cisco.com/meraki/explore/) section for open source projects, or browse the [Marketplace](https://apps.meraki.io/) for partner solutions.

In addition, several improvements and new operations have been included with this major release.
## What is a Resource

A resource is an entity or component within the Meraki ecosystem. Resources represent the various elements of a network. Here are some examples of Meraki resources:

### API Documentation
- **Organizations**: A collection of networks, representing the top-level structure in the Meraki hierarchy.
- **Networks**: Specific networks within an organization, which contain devices and configurations.
- **Devices**: Individual hardware units such as routers, switches, or access points within a network.
- **VLANs**: Virtual local area networks configured within a network for segmenting traffic.
- **SSIDs**: Wireless network identifiers that can be configured and managed.

The API operation documentation and complimenting Postman Collection have a new folder structure for navigating the API.
Each resource is typically represented by a unique URL. You can use APIs to configure or retrieve information about these resources.

## What is a Service

A service is a functionality or a set of API operations that interact with the resources of a Meraki product. (These operations are specific actions performed on a resource, such as GET, POST, PUT, or DELETE.)

#### Categories
Here are some services:

The services are grouped into categories, providing a collection of operations that behave in a similar way.
- CONFIGURE service: is a set of operations to manage cloud configurations
- MONITOR service: is a set of operations return status and history information, and
- LIVE TOOL service: is a set of operations that directly interacts with the device.

**CONFIGURE** operations are for managing cloud configurations
## What is a Meraki Product

**MONITOR** operations will return status and history information
A Meraki product refers to the hardware and software solutions offered by Cisco Meraki that are used to build and manage network infrastructure. These products include wireless access points, switches, or security appliances.

**LIVE TOOL** operations will directly interact with the device
## What is a Resource URL or Path

### Resource Path changes
The path or URL of a resource contains the name of the Meraki product to reduce ambiguity when working with resources that have similar yet unique functionality.

The operation URL paths will always contain the Meraki product if required, reducing ambiguity when working with resources that have similar yet unique functionality.
The format of the path is 'product/service'.

> **Examples of a product and service**
> **Examples of a Path:**
>
> `/appliance/ports`
>
> `/switch/ports`

### Base URI

In most parts of the world, every API request will begin with the following **base URI**:

> `https://api.meraki.com/api/v1`

For organizations hosted in different country dashboards, please refer to their [respective base URI](https://developer.cisco.com/meraki/api-v1/getting-started/#base-uri)

### See all the changes
## What is the Base URI

Visit the [Changelog](https://developer.cisco.com/meraki/whats-new/#!v1-0-0-beta-0) for all the details.
A base URI is the root address or endpoint that serves as the starting point for accessing the API's resources. The base URI includes the protocol, domain, and base path. All API requests append specific resource paths to this base URI.

### SDKs
For most regions, the base URI for API requests is `https://api.meraki.com/api/v1`.

Going forward, the custom Meraki [Python library](pythonLibrary.md) will be the recommended SDK for simplified API scripting. The previously auto-generated Python, Node.js, and Ruby SDKs for **v0** will remain in the Meraki GitHub but will no longer be maintained.
For organizations hosted in different countries, see the [respective base URI section](https://developer.cisco.com/meraki/api-v1/getting-started/#base-uri).

#### Python

The Meraki [Python Library](pythonLibrary.md) has been updated to take advantage of all the new API enhancements plus many custom features to help both beginners and experienced programmers.
Loading