What Is An API And How To Use It

api images

API stands for Application Programming Interface, it is the mechanism that enable two software components to communicate with each other using a set of definitions and protocols, This can simplify app development, saving time and money

APIs are sometimes thought of as contracts, with documentation that represents an agreement between parties: If party 1 sends a remote request structured a particular way, this is how party 2’s software will respond.

In the following example, we will make a python script together to benefit from Minelead api services.

Requirements

1- You need to have python installed

2- Install requests package using the command: pip install requests

3- Get the api key from your Minelead profile

1-Send A Post Request

We will call a remote server through its url, in this example it is the Minelead api.

Authentication

We generally need to authenticate ourselves using unique api keys to let the server know who we are and what are we authorized to do.

The api key is passed most of the time as a query string in the url, or as a header in the headers object

Following the Minelead API docs the key should be passed in the url.

In this first step, We will first try to get a list of companies from one or multiple keywords as follows:

import requests

api_key = 'api_key goes here'

api_url = 'https://api.minelead.io/v1/'

def get_companies_leads(tags):

#The url for the leads generation using keywords

url = f'{api_url}tags/?key={api_key}'

#The body of the request that contains the submitted keywords

body = {'tags':tags}

#Make the api call and return the json-encoded results

results = requests.post(url,json=body).json()

#Extract the companies' array from the response (This example will return +4000 companies)

companies = results.get('companies')

return companies

get_companies_leads(['hotel'])

Using this simple function we can retrieve thousands of leads and use them afterwards to get their emails.

Code explanation

- To pass the http request to the api we imported the requests package previously installed.

- The api should return results based on the arguments passed either in the url or in the body of the request, in this step following the docs, we should pass the keywords as an array.

- The results we get from that post request could be formatted to the json format using the json() method.

- From the response we can store the companies in a variable and return it.

2- Send A Get Request

The same way we passed a POST request to the Minelead api, there is some ressources that should be called using a GET request

but this time instead of passing arguments in requests body, we should pass them in the url as query parameters

def get_emails(tags):

#Initiate the list containing the emails for all the companies

global_emails = []

#Get the companies generated previously using keywords

companies = get_companies_leads(tags)

#Make the api call to get the companies' emails

for company in companies:

api_response = requests.get(f'{api_url}search/?domain={company}&key={api_key}').json()

#If there is emails for this company, We add them to the global emails list

if (api_response.get('status') == 'found') :

global_emails.extend(api_response.get('emails'))

#return the list containing all the emails found

return global_emails

get_emails(['hotel'])

Code explanation

- We called the function defined in the first step and stored its results in a variable.

- If we print the value of that variable we can see that it is a list of companies, which enable us to iterate over them, and that was we did.

- We passed the domain name of the company in each iteration step and formatted the response to the json format.

- For every request, if the status of response if 'found' it means that we got emails, so we add them to the list of emails defined at the top of the function.

- Finally we can return the list.

3- Store Results in a CSV File

The results we got so far are stored in variables which means that they would be lost and the memory by them taken will be freed, to store our results in this example, the best way would be to save them in a csv file.

import csv

def store_leads_in_csv(tags):

#get the emails of the companies retrieved

emails = get_emails(tags)

#open the new csv file we want our results to be stored in

with open('leads.csv','w',newline='') as file:

writer = csv.writer(file)

#write the header

writer.writerow(["email","verified","quality"])

for email in emails:

email_address = email.get('email')

verified = email.get('verified')

quality = email.get('quality')

#write the information of every email in a new row

writer.writerow([email_address,verified,quality])

store_leads_in_csv(['hotel'])

Code explanation

- Python has a great built-in module called CSV, we used it to write a CSV file and named it 'leads.csv'.

-To write in the CSV file we should initiate the writer and give the name of the outrput file and the mode (read / write / append...).

- And finally for every email we get the information needed and write in a row.

4- The Final Version

import requests

import csv

api_key = 'api_key goes here'

api_url = 'https://api.minelead.io/v1/'

def get_companies_leads(tags):

#The url for the leads generation using keywords

url = f'{api_url}tags/?key={api_key}'

#The body of the request that contains the submitted keywords

body = {'tags':tags}

#Make the api call and return the json-encoded results

results = requests.post(url,json=body).json()

#Extract the companies' array from the response (This example will return +4000 companies)

companies = results.get('companies')

return companies

def get_emails(tags):

#Initiate the list containing the emails for all the companies

global_emails = []

#Get the companies generated previously using keywords

companies = get_companies_leads(tags)

#Make the api call to get the companies' emails

for company in companies:

api_response = requests.get(f'{api_url}search/?domain={company}&key={api_key}').json()

#If there is emails for this company, We add them to the global emails list

if (api_response.get('status') == 'found') :

global_emails.extend(api_response.get('emails'))

#return the list containing all the emails found

return global_emails

def store_leads_in_csv(tags):

#get the emails of the companies retrieved

emails = get_emails(tags)

#open the new csv file we want our results to be stored in

with open('leads.csv','w',newline='') as file:

writer = csv.writer(file)

#write the header

writer.writerow(["email","verified","quality"])

for email in emails:

email_address = email.get('email')

verified = email.get('verified')

quality = email.get('quality')

#write the information of every email in a new row

writer.writerow([email_address,verified,quality])

store_leads_in_csv(['hotel'])

Conclusion

An API is just the middleman that get the requests and serve the results without the need of a graphical interface.

Using APIs to automate tasks will bring efficiency and save time and money,

电子邮件查找

公司邮箱搜索

电子邮件查找

潜在客户查找器

YouTube邮箱查找器

Twitter邮箱查找器

Google Maps电子邮件查找器

电子邮件验证

电子邮件验证

一次性电子邮件检测器

为开发人员

电子邮件查找器API

电子邮件验证 API

线索丰富 API

购买意向 API

社交邮件查找 API

一次性邮件API

API文档

扩展与集成

浏览器扩展

集成

邀请并赚取

What Is An API And How To Use It

1-Send A Post Request

Code explanation

2- Send A Get Request

Code explanation

3- Store Results in a CSV File

Code explanation

4- The Final Version

Conclusion

电话验证

不要错过

免费开始并在您的第一个计划中获得 15% 折扣